<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: AnnotatedClassScanner.html 409 2014-08-18 16:46:48Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.spring;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Annotation;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.ArrayList;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.springframework.beans.factory.config.BeanDefinition;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.springframework.core.env.Environment;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.springframework.core.io.DefaultResourceLoader;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.springframework.core.type.filter.AnnotationTypeFilter;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * Scans the classpath for classes having one or more configured type annotations.<a name="line.20"></a>
<span class="sourceLineNo">021</span> */<a name="line.21"></a>
<span class="sourceLineNo">022</span>public class AnnotatedClassScanner extends ClassPathScanningCandidateComponentProvider {<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>    // This stupid hack is required because of JLS stupidity that doesn't allow initializing final fields prior to super()<a name="line.24"></a>
<span class="sourceLineNo">025</span>    private static final ThreadLocal&lt;ArrayList&lt;Class&lt;? extends Annotation&gt;&gt;&gt; INIT_HACK = new ThreadLocal&lt;&gt;();<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    private final ArrayList&lt;Class&lt;? extends Annotation&gt;&gt; annotationTypes;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>    /**<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * Constructor. Enables use of default filters and uses a {@link org.springframework.core.env.StandardEnvironment}.<a name="line.30"></a>
<span class="sourceLineNo">031</span>     *<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * @param annotationTypes type annotations to search for<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * @throws IllegalArgumentException if {@code annotationTypes} is null, empty, or contains any non-annotation types<a name="line.33"></a>
<span class="sourceLineNo">034</span>     */<a name="line.34"></a>
<span class="sourceLineNo">035</span>    public AnnotatedClassScanner(Class&lt;?&gt;... annotationTypes) {<a name="line.35"></a>
<span class="sourceLineNo">036</span>        super(AnnotatedClassScanner.initHack(true, annotationTypes));<a name="line.36"></a>
<span class="sourceLineNo">037</span>        this.setResourceLoader(new DefaultResourceLoader());<a name="line.37"></a>
<span class="sourceLineNo">038</span>        this.annotationTypes = INIT_HACK.get();<a name="line.38"></a>
<span class="sourceLineNo">039</span>        INIT_HACK.remove();<a name="line.39"></a>
<span class="sourceLineNo">040</span>    }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Constructor.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     *<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @param useDefaultFilters whether to register the default filters for the specified {@code annotationTypes}<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @param environment environment to use<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * @param annotationTypes type annotations to search for<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * @throws IllegalArgumentException if {@code annotationTypes} is null, empty, or contains any non-annotation types<a name="line.48"></a>
<span class="sourceLineNo">049</span>     */<a name="line.49"></a>
<span class="sourceLineNo">050</span>    public AnnotatedClassScanner(boolean useDefaultFilters, Environment environment, Class&lt;?&gt;... annotationTypes) {<a name="line.50"></a>
<span class="sourceLineNo">051</span>        super(AnnotatedClassScanner.initHack(useDefaultFilters, annotationTypes), environment);<a name="line.51"></a>
<span class="sourceLineNo">052</span>        this.annotationTypes = INIT_HACK.get();<a name="line.52"></a>
<span class="sourceLineNo">053</span>        INIT_HACK.remove();<a name="line.53"></a>
<span class="sourceLineNo">054</span>    }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    private static boolean initHack(boolean rtn, Class&lt;?&gt;... annotationTypes) {<a name="line.56"></a>
<span class="sourceLineNo">057</span>        if (annotationTypes == null || annotationTypes.length == 0)<a name="line.57"></a>
<span class="sourceLineNo">058</span>            throw new IllegalArgumentException("null/empty annotationTypes");<a name="line.58"></a>
<span class="sourceLineNo">059</span>        final ArrayList&lt;Class&lt;? extends Annotation&gt;&gt; list = new ArrayList&lt;&gt;();<a name="line.59"></a>
<span class="sourceLineNo">060</span>        for (Class&lt;?&gt; cl : annotationTypes) {<a name="line.60"></a>
<span class="sourceLineNo">061</span>            try {<a name="line.61"></a>
<span class="sourceLineNo">062</span>                list.add(cl.asSubclass(Annotation.class));<a name="line.62"></a>
<span class="sourceLineNo">063</span>            } catch (ClassCastException e) {<a name="line.63"></a>
<span class="sourceLineNo">064</span>                throw new IllegalArgumentException(cl + " is not an annotation type");<a name="line.64"></a>
<span class="sourceLineNo">065</span>            }<a name="line.65"></a>
<span class="sourceLineNo">066</span>        }<a name="line.66"></a>
<span class="sourceLineNo">067</span>        INIT_HACK.set(list);<a name="line.67"></a>
<span class="sourceLineNo">068</span>        return rtn;<a name="line.68"></a>
<span class="sourceLineNo">069</span>    }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    /**<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * Locate annotated classes on the classpath. Does not actually load the classes.<a name="line.72"></a>
<span class="sourceLineNo">073</span>     *<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * @param basePackages one or more base pacakge names<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * @return list of names of classes having any of the configured type annotations<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @throws IllegalArgumentException if {@code basePackages} is empty<a name="line.76"></a>
<span class="sourceLineNo">077</span>     */<a name="line.77"></a>
<span class="sourceLineNo">078</span>    public ArrayList&lt;String&gt; scanForClasses(String... basePackages) {<a name="line.78"></a>
<span class="sourceLineNo">079</span>        if (basePackages == null || basePackages.length == 0)<a name="line.79"></a>
<span class="sourceLineNo">080</span>            throw new IllegalArgumentException("at least one base package name is required");<a name="line.80"></a>
<span class="sourceLineNo">081</span>        final ArrayList&lt;String&gt; nameList = new ArrayList&lt;&gt;();<a name="line.81"></a>
<span class="sourceLineNo">082</span>        for (String basePackage : basePackages) {<a name="line.82"></a>
<span class="sourceLineNo">083</span>            for (BeanDefinition candidate : this.findCandidateComponents(basePackage))<a name="line.83"></a>
<span class="sourceLineNo">084</span>                nameList.add(candidate.getBeanClassName());<a name="line.84"></a>
<span class="sourceLineNo">085</span>        }<a name="line.85"></a>
<span class="sourceLineNo">086</span>        return nameList;<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Register default include/exclude filters.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * &lt;p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Overridden in {@link AnnotatedClassScanner} to set the default filters to be ones that match classes<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * annotated with any of the annotation types provided to the constructor.<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * &lt;/p&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
<span class="sourceLineNo">097</span>    @Override<a name="line.97"></a>
<span class="sourceLineNo">098</span>    protected void registerDefaultFilters() {<a name="line.98"></a>
<span class="sourceLineNo">099</span>        for (Class&lt;? extends Annotation&gt; annotationType : this.annotationTypes != null ? this.annotationTypes : INIT_HACK.get())<a name="line.99"></a>
<span class="sourceLineNo">100</span>            this.addIncludeFilter(new AnnotationTypeFilter(annotationType));<a name="line.100"></a>
<span class="sourceLineNo">101</span>    }<a name="line.101"></a>
<span class="sourceLineNo">102</span>}<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>




























































</pre>
</div>
</body>
</html>
